gridpack::component::DataCollection Class Reference

#include <data_collection.hpp>

Collaboration diagram for gridpack::component::DataCollection:

[legend]

List of all members.

Public Member Functions
	DataCollection (void)
	~DataCollection (void)
DataCollection &	operator= (const DataCollection &rhs)
void	addValue (const char *name, const int value)
void	addValue (const char *name, const long value)
void	addValue (const char *name, const bool value)
void	addValue (const char *name, const char *value)
void	addValue (const char *name, const float value)
void	addValue (const char *name, const double value)
void	addValue (const char *name, const gridpack::ComplexType value)
void	addValue (const char *name, const int value, const int idx)
void	addValue (const char *name, const long value, const int idx)
void	addValue (const char *name, const bool value, const int idx)
void	addValue (const char *name, const char *value, const int idx)
void	addValue (const char *name, const float value, const int idx)
void	addValue (const char *name, const double value, const int idx)
void	addValue (const char *name, const gridpack::ComplexType value, const int idx)
bool	setValue (const char *name, const int value)
bool	setValue (const char *name, const long value)
bool	setValue (const char *name, const bool value)
bool	setValue (const char *name, const char *value)
bool	setValue (const char *name, const float value)
bool	setValue (const char *name, const double value)
bool	setValue (const char *name, const gridpack::ComplexType value)
bool	setValue (const char *name, const int value, const int idx)
bool	setValue (const char *name, const long value, const int idx)
bool	setValue (const char *name, const bool value, const int idx)
bool	setValue (const char *name, const char *value, const int idx)
bool	setValue (const char *name, const float value, const int idx)
bool	setValue (const char *name, const double value, const int idx)
bool	setValue (const char *name, const gridpack::ComplexType value, const int idx)
bool	getValue (const char *name, int *value)
bool	getValue (const char *name, long *value)
bool	getValue (const char *name, bool *value)
bool	getValue (const char *name, std::string *value)
bool	getValue (const char *name, float *value)
bool	getValue (const char *name, double *value)
bool	getValue (const char *name, gridpack::ComplexType *value)
bool	getValue (const char *name, int *value, const int idx)
bool	getValue (const char *name, long *value, const int idx)
bool	getValue (const char *name, bool *value, const int idx)
bool	getValue (const char *name, std::string *value, const int idx)
bool	getValue (const char *name, float *value, const int idx)
bool	getValue (const char *name, double *value, const int idx)
bool	getValue (const char *name, gridpack::ComplexType *value, const int idx)
void	dump (void)

---

Constructor & Destructor Documentation

gridpack::component::DataCollection::DataCollection

(

void

)

Simple constructor

gridpack::component::DataCollection::~DataCollection

(

void

)

Simple destructor

---

Member Function Documentation

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const gridpack::ComplexType	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const double	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const float	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const char *	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const bool	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const long	value,
		const int	idx
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const int	value,
		const int	idx
	)

Add variables to DataCollection object with an additional index to keep track of items that can appear more than once. Item appears in DataCollection with the tag "name:idx"

Parameters:

	name	name given to data element
	value	value of data element
	idx	index of value

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const gridpack::ComplexType	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const double	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const float	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const char *	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const bool	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const long	value
	)

void gridpack::component::DataCollection::addValue	(	const char *	name,
		const int	value
	)

Add variables to DataCollection object

Parameters:

	name	name given to data element
	value	value of data element

void gridpack::component::DataCollection::dump

(

void

)

Dump contents of data collection to standard out

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		gridpack::ComplexType *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		double *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		float *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		std::string *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		bool *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		long *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		int *	value,
		const int	idx
	)

Retrieve current value of existing data element in DataCollection object. Assume that item appears in DataCollection with the tag "name:idx"

Parameters:

	name	name of data element
	value	current value of data element
	idx	index of value

Returns:

false if no element of the correct name and type exists in DataCollection object

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		gridpack::ComplexType *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		double *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		float *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		std::string *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		bool *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		long *	value
	)

bool gridpack::component::DataCollection::getValue	(	const char *	name,
		int *	value
	)

Retrieve current value of existing data element in DataCollection object

Parameters:

	name	name of data element
	value	current value of data element

Returns:

false if no element of the correct name and type exists in DataCollection object

DataCollection& gridpack::component::DataCollection::operator=

(

const DataCollection &

rhs

)

Assignment operator

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const gridpack::ComplexType	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const double	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const float	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const char *	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const bool	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const long	value,
		const int	idx
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const int	value,
		const int	idx
	)

Modify current value of existing data element in DataCollection object. Assume that name appears in DataCollection with an additional index in the form "name:idx"

Parameters:

	name	name of data element
	value	new value of data element
	idx	index of value

Returns:

false if no element of the correct name and type exists in DataCollection object

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const gridpack::ComplexType	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const double	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const float	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const char *	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const bool	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const long	value
	)

bool gridpack::component::DataCollection::setValue	(	const char *	name,
		const int	value
	)

Modify current value of existing data element in DataCollection object

Parameters:

	name	name of data element
	value	new value of data element

Returns:

false if no element of the correct name and type exists in DataCollection object

---

The documentation for this class was generated from the following file:

• data_collection.hpp